Management API
Base Resource URL:
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-account-code]/terminals
Description:
Represents terminals created by a selected merchant.
In cases when an external identifier (Reference Code) is desired to be used instead of Terminal Code, the external identifier assigned to a terminal must be preceded by the asterisk (*).
| Terminal identification | URL |
|---|---|
| terminalCode | https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/submerchants/[merchant-account-code]/terminals/1.xml |
| referenceCode | https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/submerchants/[merchant-account-code]/terminals/*001.xml |
Available sub-resources:
| Resource URL | Description | ||||||
|---|---|---|---|---|---|---|---|
| https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-account-code]/terminals/[terminal-code] | Provides access to configuration settings for a selected terminal.
In cases when an external identifier (Reference Code) is desired to be used instead of Terminal Code, the external identifier assigned to a terminal must be preceded by the asterisk (*).
|
Supported Actions:
find
Parameters:
| Method: GET | Implicit: Yes | Returns: n/a |
| Consumes: xurl | Produces: json, xml | |
|
Returns the list of available terminals based on the specified merchantAccountCode.
|
||
Parameters:
| # | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 01 | offset | Integer | No | 0 |
Index of the first record returned to the customer from the search result of a web search. |
| 02 | limit | Integer | No | 100 |
Maximum number of records to load per single search web call made by the customer. |
Copyright ©
TidyPay. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.